Skip to main content
Feedback

How to connect to Kong

Connect your Kong Gateway to Boomi's API Control Plane.

Prerequisites

To proceed, you will need the following:

  • A running instance of Boomi's API Control Plane.

  • Access to the instance of your Kong Gateway (Open Source)

    • The Kong Gateway needs a database, otherwise neither applications nor subscriptions can be created.

  • Docker to utilize the image of our agent, which acts as an intermediary.

Create a new Environment

To get started, open your API Control Plane instance and follow the instructions below.

  1. Navigate to Environments in the menu on the left side.

  2. Select Register Gateway.

  3. Select Kong.

Choose Platform Type

  1. Set up the connection to Kong. Add the Gateway Name and URL. The URL is your Kong Management API. If you are not sure whether you have the correct URL, you can try to access <URL>/services or <URL>/consumers. Both should return a valid response and no errors.
  2. Select Next.
  3. Add the following information to the Environment Wizard:
    • Technical Name - The technical name of an API must be unique.
    • Display Name - The display name can differ from the technical name and does not have to be unique.
    • URL - The base URL at which the APIs from this environment are made available. It is used to generate the full API URL that is displayed to users after subscribing to an API.
  4. Select Connect to Gateway.
  5. Select Download and Next. A Docker file downloads.
  6. Run the specified command in the same directory of the downloaded file and select Done.

Check the Agent's Status

  1. Open your API Control Plane instance.

  2. Select Environments in the menu on the left side.

  3. Your Agent is now connected to API Control Plane. Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be very useful in case of an error.

tip

It is easy to add more agents Repeat the steps here or that of another gateway and add the agents to the existing Docker compose file.

On this Page